Add optional chunk caching to get() function
#296
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This adds optional chunk caching to the
get()function to avoid repeated decompression of chunks when accessing overlapping selections or making multiple calls to the same data. I've noticed this can be a significant bottleneck when indexing data slice-by-slice, for example, where the chunks span many slices.This may be a niche need, so no worries if this is out of scope for this library!
New API
cache?: ChunkCacheinGetOptionsChunkCacheinterface withget(key: string): Chunk<DataType> | undefinedandset(key: string, value: Chunk<DataType>): any(meant to be compatible with simpleMap)Usage
Implementation
store_N:${array.path}:${chunkKey}formatWeakMapassigns unique IDs to store instances to prevent cache collisions when sharing caches across stores (perhaps not recommended)